ODFacetIterator

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods

ODFacetIterator

Superclasses
ODObject
Subclasses
none

An object of the ODFacetIterator class provides access to all facets embedded in a facet.

Description
You use a facet iterator to apply an operation to a facet and all its embedded facets. For example, you might use a facet iterator to make sure that all facets within a facet being invalidated are also invalidated.
Your part creates a facet iterator object by calling a facet's CreateFacetIterator method (page 239), which returns a reference to a facet iterator object.
When you create a facet iterator, you specify the traversal type and sibling order. These two characteristics determine which facets are included in the iteration sequence and the order of the facets within the iteration sequence.

If you specify top-down traversal, traverse the facet hierarchy top down, in depth-first order.
If you specify bottom-up traversal, traverse the facet hierarchy bottom up, visiting the specified facet after visiting all its children. If the sibling order is front to back, the traversal starts with the frontmost facet at the lowest level in the hierarchy. If the sibling order is back to front, the traversal starts with the backmost facet at the lowest level in the hierarchy.
If you specify children-only traversal, traverse only the children of the specified facet (not including the specified facet itself).

While you are using a facet iterator, you should not modify the list of embedded facets or call the facet's MoveBefore method (page 252) or MoveBehind method (page 253). You must postpone adding facets to or removing facets from the list of embedded facets until after you have deleted the iterator.
For more information related to facet objects, see the ODFacet class description (page 219). For more information on accessing objects through iterators, see "Accessing Objects Through Iterators" on page 473 in OpenDoc Programmer's Guide.

Methods
This section presents summary descriptions of the ODFacetIterator methods grouped according to purpose, followed by detailed descriptions in alphabetical order.
Accessing

First
Begins the iteration and returns a reference to the first facet in the iteration sequence.
Next
Returns a reference to the next facet in the iteration sequence.
SkipChildren
Advances to the next sibling, skipping over the embedded facets of the current facet if the traversal type is topdown.
Iterator Testing

IsNotComplete
Returns a Boolean value that indicates whether the iteration is incomplete.

Methods
First
IsNotComplete
Next
SkipChildren